Manage orders - Gets a list of product promotions.

Gets partner's available promotions.

GET https://api.partnercenter.microsoft.com/v{version}/productpromotions
GET https://api.partnercenter.microsoft.com/v{version}/productpromotions?country={country}&segment={segment}

URI Parameters

Name In Required Type Description
version
path True

string

country
query

string

The country.

segment
query

string

The segment.

Request Header

Name Required Type Description
Authorization True

string

Authorization Bearer token

ms-correlationid

string

Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request

MS-CV

string

Used for tracking requests internally. If a MS-CV is not provided, the server will generate a new one for each request

ms-requestid

string

Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name Type Description
200 OK

ResourceCollection[Contracts.V1.Models.ProductPromotion]

The request was successful. The response body will contain a list of promotions for the partner.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

400 Bad Request

There was a missing or an invalid input. The response body will provide the error details.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

401 Unauthorized

The request was not authenticated. The client needs to authenticate with the partner API service first.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

403 Forbidden

The request was authenticated but was refused since the caller does not have the rights to invoke it.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

404 Not Found

The resource is not found or not available with the given input parameters.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

500 Internal Server Error

The partner API service or one of its dependencies failed to fulfill the request.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name Description
Contracts.V1.Models.ProductPromotion
Contracts.V1.Models.ProductPromotionPricingPolicy
Contracts.V1.Models.ProductPromotionProperties
Contracts.V1.Models.ProductPromotionRequiredProduct
Contracts.V1.Models.ProductPromotionTerm
Link
ResourceAttributes
ResourceCollection[Contracts.V1.Models.ProductPromotion]
ResourceLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]

Contracts.V1.Models.ProductPromotion

Name Type Description
description

string

endDate

string

id

string

name

string

properties

Contracts.V1.Models.ProductPromotionProperties

requiredProducts

Contracts.V1.Models.ProductPromotionRequiredProduct[]

startDate

string

Contracts.V1.Models.ProductPromotionPricingPolicy

Name Type Description
policyType

string

value

string

Contracts.V1.Models.ProductPromotionProperties

Name Type Description
isAutoApplicable

boolean

Contracts.V1.Models.ProductPromotionRequiredProduct

Name Type Description
pricingPolicies

Contracts.V1.Models.ProductPromotionPricingPolicy[]

productId

string

skuId

string

term

Contracts.V1.Models.ProductPromotionTerm

Contracts.V1.Models.ProductPromotionTerm

Name Type Description
billingCycle

string

duration

string

Name Type Description
body

string

headers

System.Collections.Generic.KeyValuePair[System.String,System.String][]

method

string

uri

string

ResourceAttributes

Name Type Description
etag

string

objectType

string

ResourceCollection[Contracts.V1.Models.ProductPromotion]

Name Type Description
attributes

ResourceAttributes

items

Contracts.V1.Models.ProductPromotion[]

links

ResourceLinks

totalCount

integer

Name Type Description
next

Link

previous

Link

self

Link

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name Type Description
key

string

value

string